Cards

Cards are a common organizing unit for modern user interfaces (UI). At their core, they’re just rectangular containers with borders and padding. However, when utilized properly to group related information, they help users better digest, engage, and navigate through content. This is why most successful dashboard/UI frameworks make cards a core feature of their component library. This article provides an overview of the API that bslib provides to create Bootstrap cards.

Setup code

To demonstrate that bslib cards work outside of Shiny (i.e., in R Markdown, static HTML, etc), we’ll make repeated use of statically rendered htmlwidgets like plotly and leaflet. Here’s some code to create those widgets:

library(bslib)
library(shiny)
library(htmltools)
library(plotly)
library(leaflet)

plotly_widget <- plot_ly(x = diamonds$cut) %>%
  config(displayModeBar = FALSE) %>%
  layout(margin = list(t = 0, b = 0, l = 0, r = 0))

leaflet_widget <- leafletOptions(attributionControl = FALSE) %>%
  leaflet(options = .) %>%
  addTiles()

Shiny usage

Cards work equally well in Shiny. In the examples below, replace plotly_widget with plotlyOutput() and leaflet_widget with leafletOutput() to adapt them for Shiny server-rendered plots/maps.

Hello `card()`

A card() is designed to handle any number of “known” card items (e.g., card_header(), card_body(), etc) as unnamed arguments (i.e., children). As we’ll see shortly, card() also has some useful named arguments (e.g., full_screen, height, etc).

At their core, card() and card items are just an HTML div() with a special Bootstrap class, so you can use Bootstrap’s utility classes to customize things like colors, text, borders, etc.

card(
  card_header(
    class = "bg-dark",
    "A header"
  ),
  card_body(
    markdown("Some text with a [link](https://github.com)")
  )
)

A header

Some text with a link

Implicit `card_body()`

If you find yourself using card_body() without changing any of its defaults, consider dropping it altogether since any direct children of card() that aren’t “known” card() items, are wrapped together into an implicit card_body() call.¹ For example, the code to the right generates HTML that is identical to the previous example:

card(
  card_header(
    class = "bg-dark",
    "A header"
  ),
  markdown("Some text with a [link](https://github.com).")
)

A header

Some text with a link.

Restricting growth

By default, a card()’s size grows to accommodate the size of it’s contents. Thus, if a card_body() contains a large amount of text, tables, etc., you may want to specify a height or max_height. That said, when laying out multiple cards, it’s likely best not to specify height on the card(), and instead, let the layout determine the height layout_column_wrap().

Although scrolling is convenient for reducing the amount of space required to park lots of content, it can also be a nuisance to the user. To help reduce the need for scrolling, consider pairing scrolling with full_screen = TRUE (which adds an icon to expand the card’s size to the browser window). Notice how, when the card is expanded to full-screen, max_height/height won’t effect the full-screen size of the card.

card(
  max_height = 250,
  full_screen = TRUE,
  card_header(
    "A long, scrolling, description"
  ),
  lorem::ipsum(paragraphs = 3, sentences = 5)
)

A long, scrolling, description

Sit consequat etiam praesent ridiculus morbi sociis tortor vitae habitant habitant porta at? Mollis est proin vel eget tellus fusce dignissim vestibulum luctus maecenas condimentum? Donec penatibus id pharetra ridiculus class, lacus egestas velit consequat feugiat primis. Tempor potenti conubia quis ad tristique netus ornare? Nascetur?

Lorem pretium maecenas, congue – suscipit pellentesque integer gravida maecenas bibendum! Et ante a fames feugiat aliquet sagittis diam. Aliquam ante cursus nibh enim nullam: arcu eros donec diam morbi dictumst. Eros dui ante cum mattis mattis metus aptent! Aliquet proin pharetra fermentum, ultricies aliquet urna mattis eleifend: lectus scelerisque elementum ullamcorper quis.

Ipsum netus pretium, netus platea dapibus lobortis. Class tortor faucibus auctor, netus interdum, condimentum nisl tortor. Mollis lobortis nascetur ridiculus quisque sodales, cras mollis curabitur nullam sodales. Lectus tempus bibendum morbi varius aptent ante eros, ligula viverra enim? Ridiculus ultrices iaculis enim vehicula felis nisl sem nostra praesent?

Filling outputs

A card()’s default behavior is optimized for facilitating filling layouts. More specifically, if a fill item (e.g., plotly_widget), appears as a direct child of a card_body(), it resizes to fit the card()s specified height. This means, by specifying height = 250 we’ve effectively shrunk the plot’s height from its default of 400 down to about 200 pixels. And, when expanded to full_screen, the plot grows to match the card()’s new size.

card(
  height = 250,
  full_screen = TRUE,
  card_header("A filling plot"),
  card_body(plotly_widget)
)

A filling plot

Most htmlwidgets (e.g., plotly, leaflet, etc) and some other Shiny output bindings (e.g, plotOutput(), imageOutput(), etc) are fill items by default, so this behavior “just works” in those scenarios. And, in some of these situations, it’s helpful to remove card_body()’s padding, which can be done via spacing & alignment utility classes.

card(
  height = 275,
  full_screen = TRUE,
  card_header("A filling map"),
  card_body(
    class = "p-0",
    leaflet_widget
  ),
  card_footer(
    class = "fs-6",
    "Copyright 2023 RStudio, PBC"
  )
)

A filling map

Fill item(s) aren’t limited in how much they grow and shrink, which can be problematic when a card becomes very small. To work around this, consider adding a min_height on the card_body() container. For example, try using the handle on the lower-right portion of this card example to make the card taller/smaller.

This interactive example is a bit contrived in that we’re using CSS resize to demonstrate how to make plots that don’t shrink beyond a certain point, but this concept becomes quite useful when implementing page-level filling layouts (i.e., page_fillable()) with multiple cards.

card(
  height = 300,
  style = "resize:vertical;",
  card_header("Plots that grow but don't shrink"),
  card_body(
    min_height = 250,
    plotly_widget,
    plotly_widget
  )
)

Plots that grow but don't shrink

Troubleshooting fill

As you’ll learn more about in filling layouts, a fill item loses its ability to fill when wrapped in additional UI element that isn’t a fillable container. To fix the situation, use as_fill_carrier() to allow the additional element to carry the potential to fill from the card_body() down to the fill item.

Multiple `card_body()`

A card() can have multiple card_body()s, which is especially useful for:

Combining both resizable and non-resizable contents (i.e., fill items and non-fill).
Allowing each card_body() to have their own styling (via inline styles and/or utility classes) and resizing limits (e.g., min_height).

For example, when pairing filling output with scrolling content, you may want min_height on the filling output since the scrolling content will force it to shrink:

card(
  height = 375,
  full_screen = TRUE,
  card_header(
    "Filling plot, scrolling description"
  ),
  card_body(
    min_height = 200,
    plotly_widget
  ),
  card_body(
    class = "lead container",
    lorem::ipsum(paragraphs = 10, sentences = 5)
  )
)

Filling plot, scrolling description

Dolor tempor hendrerit mauris sapien convallis. Vel curae elementum – sociis etiam facilisis cras mauris hendrerit! Viverra elementum laoreet dui ad arcu sociosqu; magnis metus turpis bibendum. Pharetra vulputate primis mollis enim eu hendrerit arcu. Sed hendrerit congue malesuada primis ultricies tristique; est tempus, tellus faucibus eu non, in, dui volutpat mattis consequat tincidunt vulputate lectus?

Ipsum mus ultrices integer: congue ullamcorper porttitor ultricies felis sociosqu, ligula ut congue. Placerat fermentum etiam, ultricies, urna fermentum facilisis habitant dignissim? Sed cubilia lacus auctor molestie, iaculis tristique proin posuere. Feugiat tristique ultricies magnis taciti et dictum, blandit praesent neque malesuada viverra. Neque conubia turpis erat ad rhoncus bibendum posuere vivamus hendrerit tempor vitae placerat.

Sit ut blandit dignissim dui congue leo conubia, viverra vivamus suspendisse? Leo sapien nibh lectus urna eu semper posuere, posuere integer erat luctus sollicitudin. Luctus conubia aenean pretium pretium aenean dictumst netus, taciti vulputate nulla phasellus. Ad natoque sapien est blandit eget, fames aenean taciti in? Penatibus?

Sit aliquam condimentum eleifend, turpis sem commodo interdum nulla neque. Proin integer platea viverra auctor libero congue pulvinar dapibus. Tincidunt congue ac eros bibendum vulputate nisi urna suscipit tortor curabitur. Tincidunt tellus dui scelerisque vulputate etiam hendrerit mattis mollis semper posuere commodo cras. Iaculis?

Lorem vitae vel molestie ad parturient ultrices condimentum magnis, at, sodales erat dictum nostra! Tincidunt mattis elementum aliquet, hac: integer mus semper habitasse? Massa in sodales justo tempor nostra bibendum: tellus ad, phasellus metus laoreet nisl? Libero donec tristique libero himenaeos curae, volutpat nisl lacinia. Faucibus malesuada augue velit scelerisque montes semper, facilisi, tellus aliquam nullam curabitur ornare!

Sit in lobortis suscipit mattis, ut iaculis! Ultrices pellentesque commodo – pellentesque aliquet ligula. Aenean urna, potenti lectus tellus luctus nulla nisi, feugiat malesuada class. Erat suspendisse mollis donec neque lectus parturient porta potenti dictumst. Vivamus accumsan rhoncus in libero urna quam ligula lacinia penatibus vivamus; dictumst praesent praesent maecenas fames neque.

Adipiscing nascetur nulla at eleifend odio bibendum, imperdiet auctor ullamcorper luctus. Montes luctus quisque elementum egestas nostra placerat conubia nisi volutpat, fusce blandit sem in. Parturient praesent lobortis ullamcorper elementum arcu, nullam egestas parturient donec. Porttitor malesuada facilisi – donec class praesent venenatis tempus dis scelerisque. Posuere est tortor lobortis, felis vehicula vulputate nascetur egestas.

Elit duis magnis, potenti phasellus. Libero blandit augue taciti velit, ante semper cras? Dis per taciti, donec lacus aenean, quis euismod tristique ullamcorper. Cum porttitor interdum pharetra in habitant, vehicula dignissim vulputate fermentum suspendisse. Conubia proin suspendisse vehicula porta luctus – neque at, purus ultricies eros.

Amet volutpat cubilia habitant placerat ante, vel lobortis mus volutpat torquent id quam? Tempor mauris ad nullam molestie sollicitudin nec pretium cras egestas mauris; hendrerit eu facilisi! Orci quam egestas ut mauris tempor dignissim luctus, fames nullam nullam. Vulputate purus nunc senectus proin – cum natoque volutpat posuere. Vivamus dapibus per eget hendrerit venenatis, fames erat cubilia nisi.

Amet praesent rhoncus eget mi sodales nostra cras sem. Praesent purus donec laoreet integer nascetur magna eleifend, arcu venenatis! Eros quam vel dictumst dis justo. Magna proin ullamcorper torquent in at sollicitudin; vivamus justo himenaeos hendrerit est eros. Nibh facilisis convallis velit facilisis, nibh pharetra per auctor iaculis ultrices.

Also, when the content has a fixed size, and should not be allowed to scroll, set fill = FALSE:

card(
  height = 350,
  full_screen = TRUE,
  card_header(
    "Filling plot, short description"
  ),
  plotly_widget,
  card_body(
    fill = FALSE,
    card_title("A subtitle"),
    p(class = "text-muted", "And a caption")
  )
)

Filling plot, short description

A subtitle

And a caption

Multiple columns

As you’ll learn in column-based layouts, layout_column_wrap() is great for multi-column layouts that are responsive and accommodate for filling output. Here we have an equal-width 2-column layout using width = 1/2, but it’s also possible to have varying column widths.

card(
  height = 350,
  full_screen = TRUE,
  card_header("A multi-column filling layout"),
  card_body(
    min_height = 200,
    layout_column_wrap(
      width = 1/2,
      plotOutput("p1"),
      plotOutput("p2")
    )
  ),
  lorem::ipsum(paragraphs = 3, sentences = 5)
)

A multi-column filling layout

Lorem libero cras suscipit fermentum laoreet purus, varius egestas inceptos! Placerat pulvinar aliquet tempus dictumst curae senectus curae vehicula sociosqu. Fames vulputate dignissim non donec justo himenaeos iaculis phasellus a ornare. Congue semper felis ullamcorper aliquam rhoncus. Justo sapien vestibulum sodales purus neque aliquet nisl nec hac?

Adipiscing aliquam habitasse sociis risus felis blandit. Conubia natoque, viverra habitasse at mus rutrum. Hac nisl vulputate ullamcorper parturient a taciti? Tortor quis lacus gravida erat dui ad diam ultricies. Convallis magna elementum habitasse ad laoreet lectus congue morbi auctor, odio mi; blandit ut interdum dictum vel pretium malesuada per nulla dictum auctor.

Adipiscing consequat quis iaculis accumsan nostra hendrerit, turpis, dui dui mauris? Montes leo sollicitudin dictum odio? Malesuada taciti platea, fames primis ridiculus lectus turpis cras gravida! Orci tincidunt dui pharetra at dictum, purus litora ad ligula nullam libero. Ullamcorper at hac ultrices purus aenean habitasse phasellus eros aenean interdum malesuada.

Multiple cards

layout_column_wrap() is especially nice for laying out multiple cards since each card in a particular row will have the same height (by default). Learn more in column-based layouts.

layout_column_wrap(
  width = 1/2,
  height = 300,
  card(full_screen = TRUE, card_header("A filling plot"), plotly_widget),
  card(full_screen = TRUE, card_header("A filling map"), card_body(class = "p-0", leaflet_widget))
)

A filling plot

A filling map

Multiple tabs

navset_card_tab() and navset_card_pill() make it possible to create cards with multiple tabs or pills. These functions have the same full_screen capabilities as normal card()s as well some other options like title (since there is no natural place for a card_header() to be used). Note that, each nav_panel() object is similar to a card(). That is, if the direct children aren’t already card items (e.g., card_title()), they get implicitly wrapped in a card_body().

library(leaflet)
navset_card_tab(
  height = 450,
  full_screen = TRUE,
  title = "HTML Widgets",
  nav_panel(
    "Plotly",
    card_title("A plotly plot"),
    plotly_widget
  ),
  nav_panel(
    "Leaflet",
    card_title("A leaflet plot"),
    leaflet_widget
  ),
  nav_panel(
    shiny::icon("circle-info"),
    markdown("Learn more about [htmlwidgets](http://www.htmlwidgets.org/)")
  )
)

HTML Widgets

Plotly
Leaflet

A plotly plot

A leaflet plot

Learn more about htmlwidgets

Sidebars

As you’ll learn more about in sidebar layouts, layout_sidebar() just works when placed inside in a card(). In this case, if you want fill items (e.g., plotly_widget) to still fill the card like we’ve seen before, you’ll need to set fillable = TRUE in layout_sidebar().

card(
  height = 300,
  full_screen = TRUE,
  card_header("A sidebar layout inside a card"),
  layout_sidebar(
    fillable = TRUE,
    sidebar = sidebar(
      actionButton("btn", "A button")
    ),
    plotly_widget
  )
)

A sidebar layout inside a card

Static images

card_image() makes it easy to embed static (i.e., pre-generated) images into a card. Provide a URL to href to make it clickable. In the case of multiple card_image()s, consider laying them out in multiple cards with layout_column_wrap() to produce a grid of clickable thumbnails.

card(
  height = 300,
  full_screen = TRUE,
  card_image(
    file = "shiny-hex.svg",
    href = "https://github.com/rstudio/shiny"
  ),
  card_body(
    fill = FALSE,
    card_title("Shiny for R"),
    p(
      class = "fw-light text-muted",
      "Brought to you by RStudio."
    )
  )
)

Shiny for R

Brought to you by RStudio.

Flexbox

Both card() and card_body() default to fillable = TRUE (that is, they are CSS flexbox containers), which works wonders for facilitating filling outputs, but it also leads to surprising behavior with inline tags (e.g., actionButton(), span(), strings, etc). Specifically, each inline tag is placed on a new line, but in a “normal” layout flow (fillable = FALSE), inline tags render inline.

card(
  card_body(
    fillable = TRUE,
    "Here's some", tags$i("inline"), "text",
    actionButton("btn1", "A button")
  ),
  card_body(
    fillable = FALSE,
    "Here's some", tags$i("inline"), "text",
    actionButton("btn2", "A button")
  )
)

Here's some inline text

That said, sometimes working in a flexbox layout is quite useful, even when working with inline tags. Here we leverage flexbox’s gap property to control the spacing between a plot, a (full-width) button, and paragraph. Note that, by using markdown() for the paragraph, it wraps the results in a <p> tag, which means the contents of the paragraph are not longer subject to flexbox layout. If we wanted, we could do something similar to render the actionButton() inline by wrapping it in a div().

card(
  height = 325, full_screen = TRUE,
  card_header("A plot with an action links"),
  card_body(
    class = "gap-2 container",
    plotly_widget,
    actionButton(
      "go_btn", "Action button",
      class = "btn-primary rounded-0"
    ),
    markdown("Here's a _simple_ [hyperlink](https://www.google.com/).")
  )
)

A plot with an action links

Here's a simple hyperlink.

In addition to gap, flexbox has really nice ways of handling otherwise difficult spacing and alignment issues. And, thanks to Bootstrap’s flex utility classes, we can easily opt-in and customize defaults.

card(
  height = 300, full_screen = TRUE,
  card_header(
    class = "d-flex justify-content-between",
    "Centered plot",
    checkboxInput("check", " Check me", TRUE)
  ),
  card_body(
    class = "align-items-center",
    plotOutput("id", width = "75%")
  )
)

Centered plot

Check me

Shiny

Since this article is statically rendered, the examples here use statically rendered content/widgets, but the same card() functionality works for dynamically rendered content via Shiny (e.g., plotOutput(), plotlyOutput(), etc).

An additional benefit that comes with using shiny is the ability to use getCurrentOutputInfo() to render new/different content when the output container becomes large enough, which is particularly useful with card(full_screen = T, ...). For example, you may want additional captions/labels when a plot is large, additional controls on a table, etc (see the value boxes article for a clever use of this).

# UI logic
ui <- page_fluid(
  card(
    max_height = 200,
    full_screen = TRUE,
    card_header("A dynamically rendered plot"),
    plotOutput("plot_id")
  )
)

# Server logic
server <- function(input, output, session) {
  output$plot_id <- renderPlot({
    info <- getCurrentOutputInfo()
    if (info$height() > 600) {
      # code for "large" plot
    } else {
      # code for "small" plot
    }
  })
}

shinyApp(ui, server)

Appendix

The following CSS is used to give plotOutput() a background color; it’s necessary here because this documentation page is not actually hooked up to a Shiny app, so we can’t show a real plot.

.shiny-plot-output {
  background-color: #216B7288;
  height: 400px;
  width: 100%;
}